<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: guistep</title>
    
    <script src="http://shjs.sourceforge.net/sh_main.min.js"> </script>
    <script src="http://shjs.sourceforge.net/lang/sh_javascript.min.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/node-dark.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">
    
    <h1 class="page-title">Class: guistep</h1>
    
    



<section>
    
<header>
    <h2>
    guistep
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
    
        
<dt>
    <h4 class="name" id="guistep"><span class="type-signature"></span>new guistep</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This constructor is used to create a guistep object.
    </div>
    
    
    
    
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 7</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

    
    </div>
    
    
    
    
    
    
    
    
    
    
    
    
        <h3 class="subsection-title">Members</h3>
        
        <dl>
            
<dt>
    <h4 class="name" id="nextLineDisabled"><span class="type-signature">&lt;static> </span>nextLineDisabled<span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        This boolean attribute of guistep tells if the function nextLine is disabled.
    </div>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 35</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
</dd>

        
            
<dt>
    <h4 class="name" id="nextStepDisabled"><span class="type-signature">&lt;static> </span>nextStepDisabled<span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        This boolean attribute of guistep tells if the function nextStep is disabled.
    </div>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 40</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
</dd>

        
            
<dt>
    <h4 class="name" id="prevLineDisabled"><span class="type-signature">&lt;static> </span>prevLineDisabled<span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        This boolean attribute of guistep tells if the function prevLine is disabled.
    </div>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 45</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
</dd>

        
            
<dt>
    <h4 class="name" id="prevStepDisabled"><span class="type-signature">&lt;static> </span>prevStepDisabled<span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        This boolean attribute of guistep tells if the function prevStep is disabled.
    </div>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 50</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
</dd>

        
            
<dt>
    <h4 class="name" id="rightValue"><span class="type-signature">&lt;static> </span>rightValue<span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        This boolean attribute of guistep tells if the user input was wrong or right.
    </div>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 65</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
</dd>

        
            
<dt>
    <h4 class="name" id="xMarked"><span class="type-signature">&lt;static> </span>xMarked<span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        This number attribute of guistep is used so the marking of wrong or right input of the user can be visualized.
    </div>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 55</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
</dd>

        
            
<dt>
    <h4 class="name" id="yMarked"><span class="type-signature">&lt;static> </span>yMarked<span class="type-signature"></span></h4>
    
    
</dt>
<dd>
    
    <div class="description">
        This number attribute of guistep is used so the marking of wrong or right input of the user can be visualized.
    </div>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 60</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
</dd>

        </dl>
    
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl>
            
<dt>
    <h4 class="name" id="changeMode"><span class="type-signature">&lt;static> </span>changeMode</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This function is used to change from showing the complete result to use the step by step mode. Some preparation needs to
	be done and this si made with this function (i.e disable/enable sequence textfields or clear/fill the matrix).
    </div>
    
    
    
    
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 71</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

        
            
<dt>
    <h4 class="name" id="getCellExplanation"><span class="type-signature">&lt;static> </span>getCellExplanation</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This function is used to return the specific explanation for the bubble explaining a cell.
    </div>
    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>xPos</code></td>
            
            
            <td class="type">
            
                        number
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">position x in the array</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>yPos</code></td>
            
            
            <td class="type">
            
                        number
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">position y in the array</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>givenValue</code></td>
            
            
            <td class="type">
            
                        number
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">value given by the user</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 227</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

        
            
<dt>
    <h4 class="name" id="getPathExplanation"><span class="type-signature">&lt;static> </span>getPathExplanation</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This function is used to return the specific explanation for the bubble explaining a part of the alignment.
    </div>
    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>xPos</code></td>
            
            
            <td class="type">
            
                        number
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">position x in the matrix</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>yPos</code></td>
            
            
            <td class="type">
            
                        number
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">position y in the matrix</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>nextXPos</code></td>
            
            
            <td class="type">
            
                        number
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">following position x in the matrix</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>nextYPos</code></td>
            
            
            <td class="type">
            
                        number
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">following position y in the matrix</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 327</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

        
            
<dt>
    <h4 class="name" id="getUserInput"><span class="type-signature">&lt;static> </span>getUserInput</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This function is used to allocate the input of the user.
    </div>
    
    
    
    
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 454</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

        
            
<dt>
    <h4 class="name" id="handleControlStyle"><span class="type-signature">&lt;static> </span>handleControlStyle</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This function is used to handle the style of the step by step buttons.
    </div>
    
    
    
    
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 189</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

        
            
<dt>
    <h4 class="name" id="prepareShownArray"><span class="type-signature">&lt;static> </span>prepareShownArray</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This function prepares a copy of the algorithm.array by including the current step.
    </div>
    
    
    
    
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 384</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

        
            
<dt>
    <h4 class="name" id="stepCall"><span class="type-signature">&lt;static> </span>stepCall</h4>
    
    
</dt>
<dd>
    
    
    <div class="description">
        This function is used for the step by step mode to make one or more steps. Therefore the parameter call is used
	to give the direction.
    </div>
    
    
    
    
    
        <h5>Parameters:</h5>
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>call</code></td>
            
            
            <td class="type">
            
                        string
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">'next', 'nextLine', 'prevLine', 'prev' or nothing</td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>butObj</code></td>
            
            
            <td class="type">
            
                        dom element
                        
                    
            </td>
            
            
            
            
            
            <td class="description last">is used to check, if the button is disabled</td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>guistep.js, line 116</li></ul></dd>
	
    
    
	
	
	
	
</dl>

    
    
    
    
    
    
    
    
</dd>

        </dl>
    
    
    
    
    
</article>

</section>  




</div>

<nav>
    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="algorithm.html">algorithm</a></li><li><a href="cellInfo.html">cellInfo</a></li><li><a href="gui.html">gui</a></li><li><a href="guistep.html">guistep</a></li></ul><h3>Global</h3><ul><li><a href="global.html#$">$</a></li><li><a href="global.html#debug">debug</a></li></ul>
</nav>

<br clear="both">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3</a> on Wed Jul 25 2012 23:08:27 GMT+0200 (MESZ)
</footer>

<script> sh_highlightDocument(); </script>
</body>
</html>
